home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / arcers / quantum / quantum.doc < prev    next >
Text File  |  1994-07-19  |  10KB  |  256 lines
  1.  
  2.  
  3.                                 QUANTUM
  4.  
  5.                 An advanced data compressor and archiver
  6.  
  7.  
  8. Copyright (c) 1993,1994 Cinematronics
  9. All rights reserved
  10.  
  11. Cinematronics
  12. 223 River Street
  13. Santa Cruz, CA 95060
  14.  
  15. The latest version of Quantum is available on the Cinematronics BBS.
  16. The modem phone number is (408) 457-9047.  Use the GUEST account (no
  17. password is needed for this account).
  18.  
  19.  
  20. Contents
  21. --------------------------------------------------------------------------
  22.  
  23. 1. Description
  24. 2. Notes
  25. 3. Compressor command-line parameters
  26. 4. Decompressor command-line parameters
  27. 5. Archive file format
  28. 6. @ (at) response file format
  29. 7. Disclaimer
  30.  
  31.  
  32.  
  33. 1. Description
  34. --------------------------------------------------------------------------
  35.  
  36. This is version 0.93, a beta version.  This beta version is being made
  37. available to the public.  You may distribute this version freely
  38. provided that all of the files are kept intact and unmodified.  No
  39. technical support is available at this time.
  40.  
  41. This version is fully functional with the following provisions:
  42.  
  43.  1. No attempt was made to optimize for speed in the 32-bit tools.
  44.     The 16-bit Windows decompressor is optimized and is much faster.
  45.     For the moment we are concentrating on improving the compression
  46.     ratio and adding features to the archiver.  Future versions of
  47.     the 32-bit tools will be faster.
  48.  
  49.  2. Decompressing individual files isn't supported in this version
  50.     of the 32-bit decompressor.  The Windows decompressor supports
  51.     selective decompression.
  52.  
  53.  
  54. 2. Notes
  55. --------------------------------------------------------------------------
  56.  
  57. Quantum is a state-of-the-art data compressor which is designed to
  58. optimize for space over time.  Three programs are included: PAQ, UNPAQ
  59. and QWIN.  Each of these require at least a 386 CPU to run.  PAQ and
  60. UNPAQ are 32-bit DOS programs and require the Borland DPMI DOS extender.
  61. QWIN is a Windows program.
  62.  
  63. Usage instructions are available by running the programs with no
  64. command-line parameters.  PAQ can accept individual file names on the
  65. command-line but you may find it useful to list the files to be archived
  66. in a text file and reference that file name by putting an at-sign ("@")
  67. in front of the name.  Quantum archive file names generally end in a .Q
  68. but you can name them anything you wish if you explicitly provide the
  69. file name suffix.
  70.  
  71. Quantum is smart enough to detect when its output is being redirected to
  72. a file and avoids displaying the running percent-complete information so
  73. your log file will contain only what it should.
  74.  
  75. If you want to run the 32-bit tools in a Windows DOS box you will
  76. need to install WINDPMI.386 in the [386Enh] section of your SYSTEM.INI
  77. file.  The SYSTEM.INI file is located in your Windows directory and
  78. you can edit it with any text editor (such as NotePad).  Look for the
  79. line which reads [386Enh] and this immediately after it:
  80.  
  81. device=c:\quantum\windpmi.386
  82.  
  83. This assumes you put WINDPMI.386 in the C:\QUANTUM directory.  If you
  84. put it elsewhere be sure to put in the correct path name.  If you have
  85. the wrong path name Windows will complain when it starts up.
  86.  
  87. After modifying SYSTEM.INI save it and exit and restart Windows for
  88. the change to take effect.
  89.  
  90.  
  91. 3. Compressor command-line parameters
  92. --------------------------------------------------------------------------
  93.  
  94.   -c[1..5]  Compression level (default = 3)
  95.   -s[+|-]   Sort files by extension/name (default = '+')
  96.   -t??      Table size (default = 18)
  97.   -l??      Limit on archive file size
  98.   -r        Recurse subdirectories
  99.   -p        Store paths
  100.  
  101. The -t compressor parameter affects the memory table size which is used
  102. during both compression and decompression.  This value can range from 10
  103. to 21 with a default of 18.  The amount of memory required in the
  104. decompressor for each table size setting is:
  105.  
  106.           10:      1K
  107.           11:      2K
  108.           12:      4K
  109.           13:      8K
  110.           14:     16K
  111.           15:     32K
  112.           16:     64K
  113.           17:    128K
  114.           18:    256K
  115.           19:    512K
  116.           20:  1,024K
  117.           21:  2,048K
  118.  
  119. As you would expect, larger table sizes generally result in better
  120. compression but the improvement curve tends to flatten out.
  121.  
  122. The table size reflects the amount of memory required by the
  123. decompressor but the compressor needs about six times this amount.
  124. A 20-bit table will require one megabyte for decompression and about
  125. six megabytes for compression.
  126.  
  127. The compressor "does the right thing".  It may elect to use a smaller
  128. table size than the one you requested if it sees that the larger size
  129. is unnecessary.  It will never use a larger size than you requested.
  130.  
  131. The -c parameter controls the compression level.  The compression level
  132. does NOT effect decompression speed.
  133.  
  134. Lower levels compress faster.  Higher levels compress better.
  135.  
  136. The levels one to four are good choices for everyday compression.
  137. Level five is substantially slower and large jobs may take several
  138. minutes or even hours but it achieves very tight compression.
  139.  
  140. Results will vary depending on the nature of the data you are
  141. compressing but I have found that for most cases each compression level
  142. tends to be from one to five percent better than the previous level.
  143.  
  144. The -s parameter controls whether file names are sorted before adding
  145. them to the archive.  Sorting is keyed first by extension and second by
  146. name.  This heuristic helps to organize files of similar types to be
  147. nearer each other in the archive which improves the compression ratio.
  148. If you disable sorting please be try to keep files of similar types
  149. grouped together for maximum benefit.
  150.  
  151. The -l parameter sets the maximum size of a single volume.  Quantum can
  152. break up an archive into multiple files so you can pack one archive
  153. across many floppy disks.  Use -l as many times as you wish to specify
  154. the size of each volume.  This can be very useful when you want to
  155. spread an archive across the free space of several disks.  For example,
  156. products often ship with some uncompressed files on the first disk (such
  157. as the install program) and you might plan to fill out the remaining
  158. free space with the first volume of the archive but the following
  159. volumes can be as large as a disk.  In this case you might use a
  160. command line like this:
  161.  
  162. paq -l831488 -l1457664 arc.q *.*
  163.  
  164. The first -l parameter tells Paq to make the first volume no larger than
  165. 831488 bytes (in our example, the amount of free space remaining on disk
  166. one).  The second -l parameter tells Paq to make the second and all
  167. subsequent volumes no larger than 1457664 bytes (the size of a 3.5" disk).
  168. Use as many -l parameters as you need.
  169.  
  170. The -r parameter controls directory traversal.  Use it to store all
  171. the files in a subdirectory tree.  NOTE: If you need to store the
  172. paths as well you will need to use the -p switch.
  173.  
  174. The -p parameter stores the paths of files into the archive.
  175.  
  176.  
  177. 4. Decompressor command-line parameters
  178. --------------------------------------------------------------------------
  179.  
  180.   -x      eXtract files (default)
  181.   -v      View the contents of an archive
  182.   -d      Restore Directory structure
  183.   -t      Test archive integrity
  184.  
  185. The -x parameter extracts files.  Use -v to view the contents of an
  186. archive.   The -t parameter tests an archive's integrity without
  187. actually decompressing the files.
  188.  
  189. The -d parameter will restore the directory structure contained within
  190. the archive.
  191.  
  192.  
  193. 5. Archive file format
  194. --------------------------------------------------------------------------
  195.  
  196. The format of a Quantum archive is very simple.  The first part consists
  197. of a header which identifies the file as a Quantum archive and includes a
  198. list of the files which reside in the archive.  It looks like this:
  199.  
  200. (NOTE: The file format is subject to change.)
  201.  
  202. Bytes     Description
  203. -----     -----------
  204.   2       Signature, must be 0x44 followed by 0x53.
  205.   1       Major version number.
  206.   1       Minor version number.
  207.   2       The number of files which reside in this archive.
  208.   1       The table size required for decompression.
  209.   1       Compression flags.
  210.  
  211. This is immediately followed by the list of files:
  212.  
  213. Bytes     Description
  214. -----     -----------
  215.  Var.     The length of the file name.  See (*) below.
  216.  Var.     The file name.  Variable length string.  Not zero-terminated.
  217.  Var.     The length of the comment field.  See (*) below.
  218.  Var.     The comment field.  Variable length string.  Not zero-terminated.
  219.   4       The fully expanded file size in bytes.
  220.   2       The file time (DOS format).
  221.   2       The file date (DOS format).
  222.  
  223. (*) Strings are prefixed with their length.  This takes one or two
  224. bytes. If the length is less than 128 then it is stored directly in one
  225. byte.  If it is greater than 127 then the high bit of the first byte is
  226. set to 1 and the remaining fifteen bits contain the actual length in
  227. big-endian format.
  228.  
  229. Immediately following the list of files is the compressed data.
  230.  
  231.  
  232. 6. @ (at) response file format
  233. --------------------------------------------------------------------------
  234.  
  235. Each line begins with a file name.  Other fields are optional.
  236.  
  237. A : The alias for the file.  This becomes the file name in the archive.
  238. D : Date, in MM/DD/YY format.
  239. T : Time, in 24-hour HH:MM:SS format.
  240. C : Comment field, a string.  Since this may include spaces this must
  241.     be the last field on the line.  Terminated with a <CR>.
  242.  
  243. Ex:
  244.  
  245. \bin\bcc.exe  Acc.exe  D01/01/94  T01:00:00  CThe command-line compiler.
  246.  
  247.  
  248. 7. Disclaimer
  249. --------------------------------------------------------------------------
  250.  
  251. Cinematronics disclaims all warranties as to this software, whether
  252. express or implied, including without limitation any implied warranties
  253. of merchantability, fitness for any purpose, functionality, data
  254. integrity or protection.  Use of this software is entirely at your own
  255. risk.
  256.